Add User To Group
AutomatR.AWS.Activities.AddUserToGroup
The "Add User To Group" activity in AutomatR is part of the AWS IAM (Identity and Access Management) activities package, allowing automation processes to add a user account to a specified IAM group within Amazon Web Services (AWS).
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the Amazon Recognition service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the Amazon Recognition service. String variables containing the secret access key. |
| Region | Specifies the region in which the IAM group is located. Use the RegionEndpoint enumeration to set the region. |
| User Name | Specifies the name of the IAM user to be added to the group. String variables containing the IAM user name. |
| Group Name | Specifies the name of the IAM group to which the user will be added. String variables containing the IAM group name. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Add User To Group" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs the result of the "Add User To Group" operation, indicating whether the user was successfully added to the group or any encountered errors. Variables of relevant types (e.g., Boolean variables) to store the operation result. |
How to use:
- Drag and drop the "Add User To Group" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, user name, and group name.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to add the specified IAM user to the specified IAM group within AWS.
Example: Consider an example where the "Add User To Group" activity is used to add a user named "john_doe" to an IAM group named "Admins":
Add User To Group:
Display Name: "Add John Doe to Admins"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-west-2"
User Name: "john_doe"
Group Name: "Admins"
Result: isUserAddedToGroup
In this example, the activity attempts to add the user "john_doe" to the "Admins" IAM group within the specified AWS region. The result of the operation (success or failure) is stored in the Boolean variable "isUserAddedToGroup" for further handling in the workflow.